Prevent double uri decoding #9532

bluwy · 2023-12-27T15:29:07Z

Changes

Fix #7374

Prevent unnecessary decoding in certain places. I'll add comments below to explain it.

Testing

Added a test

Docs

n/a. bug fix.

changeset-bot · 2023-12-27T15:29:11Z

🦋 Changeset detected

Latest commit: 1692f1e

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

bluwy · 2023-12-27T15:30:06Z

packages/astro/src/core/routing/params.ts

-				params[key.slice(3)] = match[i + 1] ? decodeURIComponent(match[i + 1]) : undefined;
+				params[key.slice(3)] = match[i + 1] ? match[i + 1] : undefined;
 			} else {
-				params[key] = decodeURIComponent(match[i + 1]);
+				params[key] = match[i + 1];


This getParams function is being called at

astro/packages/astro/src/core/render/params-and-props.ts

Lines 63 to 72 in cf993bc

function getRouteParams(route: RouteData, pathname: string): Params | undefined {

if (route.params.length) {

// The RegExp pattern expects a decoded string, but the pathname is encoded

// when the URL contains non-English characters.

const paramsMatch = route.pattern.exec(decodeURIComponent(pathname));

if (paramsMatch) {

return getParams(route.params)(paramsMatch);

}

}

}

As shown, it already calls decodeURIComponent, so we don't have to call decodeURIComponent here too.

bluwy · 2023-12-27T15:31:58Z

packages/astro/src/vite-plugin-astro-server/request.ts

-		pathname = decodeURI(url.pathname);
+		pathname = url.pathname;


It doesn't look like we need to decode it here. It also doesn't work well with the line below:

astro/packages/astro/src/vite-plugin-astro-server/request.ts

Lines 43 to 44 in cf993bc

// Add config.base back to url before passing it to SSR

url.pathname = removeTrailingForwardSlash(config.base) + url.pathname;

(URLs are always encoded)

Removing this decodeURI seems to not break things. It affects dev only. The prod SSR "app" also doesn't decode the url, so I think this makes it more consistent.

Prevent double uri decoding

1692f1e

github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Dec 27, 2023

bluwy commented Dec 27, 2023

View reviewed changes

matthewp approved these changes Dec 27, 2023

View reviewed changes

matthewp merged commit 7224809 into main Dec 27, 2023
13 checks passed

matthewp deleted the no-double-decode branch December 27, 2023 17:34

astrobot-houston mentioned this pull request Dec 27, 2023

[ci] release #9491

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent double uri decoding #9532

Prevent double uri decoding #9532

bluwy commented Dec 27, 2023

changeset-bot bot commented Dec 27, 2023

bluwy Dec 27, 2023

bluwy Dec 27, 2023

	function getRouteParams(route: RouteData, pathname: string): Params \| undefined {
	if (route.params.length) {
	// The RegExp pattern expects a decoded string, but the pathname is encoded
	// when the URL contains non-English characters.
	const paramsMatch = route.pattern.exec(decodeURIComponent(pathname));
	if (paramsMatch) {
	return getParams(route.params)(paramsMatch);
	}
	}
	}

	// Add config.base back to url before passing it to SSR
	url.pathname = removeTrailingForwardSlash(config.base) + url.pathname;

Prevent double uri decoding #9532

Prevent double uri decoding #9532

Conversation

bluwy commented Dec 27, 2023

Changes

Testing

Docs

changeset-bot bot commented Dec 27, 2023

🦋 Changeset detected

bluwy Dec 27, 2023

Choose a reason for hiding this comment

bluwy Dec 27, 2023

Choose a reason for hiding this comment